Class VariableImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.VariableImpl
All Implemented Interfaces:
IPCObject, Variable

public class VariableImpl extends IPCObjectImpl implements Variable
Information provided by the PKI file:

    \class Variable
    
    \brief Variable is the base class for variables in the VariableManager.
    
    \example appWindow().getActiveFile().getVariableManager().getVariable(0)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • name

      public String name()
      Information provided by the PKI file:
      
          \brief Returns the name of the variable.
          
          \return QString, the name of the variable.
          
              
      Specified by:
      name in interface Variable
      Returns:
      String Returns a String
    • valueToString

      public String valueToString()
      Information provided by the PKI file:
      
          \brief Returns the value of the variable.
          
          \return QString, the value of the variable.
          
              
      Specified by:
      valueToString in interface Variable
      Returns:
      String Returns a String
    • valueOfIndex

      public String valueOfIndex(int index)
      Information provided by the PKI file:
      
          \brief Returns the value of the variable at the specified index.
          
          \param index, the index of the variable of interest.
          
          \return QString, the value of the variable.
          
              
      Specified by:
      valueOfIndex in interface Variable
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • getPool

      public Pool getPool()
      Information provided by the PKI file:
      
          \brief Returns the pool that this variable is associated with.
          
          \return Pool, the Pool object that this variable is associated with.
          
              
      Specified by:
      getPool in interface Variable
      Returns:
      Pool Returns a Pool
    • isInPool

      public boolean isInPool(String value)
      Information provided by the PKI file:
      
          \brief Returns true if the specified value is in the pool, otherwise false.
          
          \param value, the value of interest.
          
          \return bool, true if the specified value is in the pool, otherwise false.
          
              
      Specified by:
      isInPool in interface Variable
      Parameters:
      value - Takes in a parameter of value
      Returns:
      boolean Returns a boolean
    • getType

      public VARIABLETYPE getType()
      Information provided by the PKI file:
      
          \brief Returns the type of the variable.
          
          \return VARIABLETYPE,       the type of the variable.
          Variable types:     ENTIRE_RANGE = 0,
          RANDOM = 1,
          STATIC = 2,
          SEED = 3
          
              
      Specified by:
      getType in interface Variable
      Returns:
      VARIABLETYPE Returns a VARIABLETYPE